Add skills setup info to docs #2823
Conversation
To support workflow for setting up skills locally, a symlink is suggested to be created in the root directory. These files should not be committed. Add common directories for skills configuration.
Docs mention that skills live in .github/skills but most if not all tools don't support this. Add information on how to set up a symlink to get desired skill functionality.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2823 +/- ##
==========================================
+ Coverage 71.85% 72.18% +0.33%
==========================================
Files 134 134
Lines 7340 7449 +109
Branches 1563 1527 -36
==========================================
+ Hits 5274 5377 +103
- Misses 2020 2026 +6
Partials 46 46 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| ## AI Skills | ||
|
|
||
| Skills are designed to improve AI agent performance by providing structured instructions and resources for specific tasks. This is applicable to any AI agent with skill support, and developers can point AI agents to the skills directory for structured task handling. | ||
| Skills are designed to improve AI agent performance by providing structured instructions and resources for specific tasks. Skills are best used in conjunction with tools that support skill use, though agents can be manually directed to use the skills as well. |
There was a problem hiding this comment.
should we also cautious against using skills downloaded online blindly without auditing it due to security concerns?
There was a problem hiding this comment.
Oh you mean like those you just download online without adding to the repo first?
Hmm, I feel like that's quite a given but maybe it'd be good to say that quiet part out loud ah (i.e. don't be stupid lol).
Maybe something like:
Do not use Skills found online without auditing them first. It is also strongly recommended to create a separate pull request to review the Skill before proper use.
yihao03
left a comment
yihao03
left a comment
There was a problem hiding this comment.
LGTM! Why is vibecoding hard now
| Skills are located in the `.github/skills/` directory. You can point AI agents to this directory to leverage the structured instructions and resources provided by the skills. | ||
| ### Setting up Skills | ||
|
|
||
| Skills are located in the `.github/skills/` directory. Many tools and agents require different directory structures to enable skill use. It is suggested to set up symlinks for the specific directory structure required. |
There was a problem hiding this comment.
I understand that you have added some popular ai directories to the .gitignore. Do you think we can also mention that whoever using some other ai agents or repositories should also populate the .gitignore accordingly?
|
Moved to #2804 |
2 participants
What is the purpose of this pull request?
Overview of changes:
Update developer documentation on how to setup tool-specific skills directory. Also update .gitignore to exclude commonly used configuration directories.
Anything you'd like to highlight/discuss:
Testing instructions:
Proposed commit message: (wrap lines at 72 characters)
Add AI skills setup info to developer docs
Checklist: ☑️
Reviewer checklist:
Indicate the SEMVER impact of the PR:
At the end of the review, please label the PR with the appropriate label:
r.Major,r.Minor,r.Patch.Breaking change release note preparation (if applicable):